<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.9"/>
<title>NGUI: UIPlayTween Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { init_search(); });
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">NGUI
   &#160;<span id="projectnumber">3.11.0</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="hierarchy.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('class_u_i_play_tween.html','');});
</script>
<div id="doc-content">
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="#pub-static-attribs">Static Public Attributes</a> &#124;
<a href="class_u_i_play_tween-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">UIPlayTween Class Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>Play the specified tween on click.  
 <a href="class_u_i_play_tween.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for UIPlayTween:</div>
<div class="dyncontent">
 <div class="center">
  <img src="class_u_i_play_tween.png" usemap="#UIPlayTween_map" alt=""/>
  <map id="UIPlayTween_map" name="UIPlayTween_map">
</map>
 </div></div>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a0c0efabeb715240734cedbef8756b8ee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a0c0efabeb715240734cedbef8756b8ee">Play</a> (bool forward)</td></tr>
<tr class="memdesc:a0c0efabeb715240734cedbef8756b8ee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Activate the tweeners.  <a href="#a0c0efabeb715240734cedbef8756b8ee">More...</a><br /></td></tr>
<tr class="separator:a0c0efabeb715240734cedbef8756b8ee"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a37528d9cfda968571e39a90d7b63df46"><td class="memItemLeft" align="right" valign="top">GameObject&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a37528d9cfda968571e39a90d7b63df46">tweenTarget</a></td></tr>
<tr class="memdesc:a37528d9cfda968571e39a90d7b63df46"><td class="mdescLeft">&#160;</td><td class="mdescRight">Target on which there is one or more tween.  <a href="#a37528d9cfda968571e39a90d7b63df46">More...</a><br /></td></tr>
<tr class="separator:a37528d9cfda968571e39a90d7b63df46"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac5c180c12d5c121bbda64913156612e5"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#ac5c180c12d5c121bbda64913156612e5">tweenGroup</a> = 0</td></tr>
<tr class="memdesc:ac5c180c12d5c121bbda64913156612e5"><td class="mdescLeft">&#160;</td><td class="mdescRight">If there are multiple tweens, you can choose which ones get activated by changing their group.  <a href="#ac5c180c12d5c121bbda64913156612e5">More...</a><br /></td></tr>
<tr class="separator:ac5c180c12d5c121bbda64913156612e5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:aaba49f1661ff32e1b2dd7b735cb8081e"><td class="memItemLeft" align="right" valign="top">Trigger&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#aaba49f1661ff32e1b2dd7b735cb8081e">trigger</a> = Trigger.OnClick</td></tr>
<tr class="memdesc:aaba49f1661ff32e1b2dd7b735cb8081e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Which event will trigger the tween.  <a href="#aaba49f1661ff32e1b2dd7b735cb8081e">More...</a><br /></td></tr>
<tr class="separator:aaba49f1661ff32e1b2dd7b735cb8081e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afc50e0d18500e896042ee2730cf5f8bc"><td class="memItemLeft" align="right" valign="top">Direction&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#afc50e0d18500e896042ee2730cf5f8bc">playDirection</a> = Direction.Forward</td></tr>
<tr class="memdesc:afc50e0d18500e896042ee2730cf5f8bc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Direction to tween in.  <a href="#afc50e0d18500e896042ee2730cf5f8bc">More...</a><br /></td></tr>
<tr class="separator:afc50e0d18500e896042ee2730cf5f8bc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a020e266016053125fc564ea00ea061a0"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a020e266016053125fc564ea00ea061a0">resetOnPlay</a> = false</td></tr>
<tr class="memdesc:a020e266016053125fc564ea00ea061a0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the tween will be reset to the start or end when activated. If not, it will continue from where it currently is.  <a href="#a020e266016053125fc564ea00ea061a0">More...</a><br /></td></tr>
<tr class="separator:a020e266016053125fc564ea00ea061a0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5b0fcbcbc3c97ff232176b68301f8dab"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a5b0fcbcbc3c97ff232176b68301f8dab">resetIfDisabled</a> = false</td></tr>
<tr class="memdesc:a5b0fcbcbc3c97ff232176b68301f8dab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the tween will be reset to the start if it's disabled when activated.  <a href="#a5b0fcbcbc3c97ff232176b68301f8dab">More...</a><br /></td></tr>
<tr class="separator:a5b0fcbcbc3c97ff232176b68301f8dab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a24e2ad0283d4eca2117c1e16cef8bf0b"><td class="memItemLeft" align="right" valign="top">EnableCondition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a24e2ad0283d4eca2117c1e16cef8bf0b">ifDisabledOnPlay</a> = EnableCondition.DoNothing</td></tr>
<tr class="memdesc:a24e2ad0283d4eca2117c1e16cef8bf0b"><td class="mdescLeft">&#160;</td><td class="mdescRight">What to do if the tweenTarget game object is currently disabled.  <a href="#a24e2ad0283d4eca2117c1e16cef8bf0b">More...</a><br /></td></tr>
<tr class="separator:a24e2ad0283d4eca2117c1e16cef8bf0b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac54da7807c5285be86e60e1a1d4e4489"><td class="memItemLeft" align="right" valign="top">DisableCondition&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#ac54da7807c5285be86e60e1a1d4e4489">disableWhenFinished</a> = DisableCondition.DoNotDisable</td></tr>
<tr class="memdesc:ac54da7807c5285be86e60e1a1d4e4489"><td class="mdescLeft">&#160;</td><td class="mdescRight">What to do with the tweenTarget after the tween finishes.  <a href="#ac54da7807c5285be86e60e1a1d4e4489">More...</a><br /></td></tr>
<tr class="separator:ac54da7807c5285be86e60e1a1d4e4489"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a723dcbc852edfe53697136179b455111"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a723dcbc852edfe53697136179b455111">includeChildren</a> = false</td></tr>
<tr class="memdesc:a723dcbc852edfe53697136179b455111"><td class="mdescLeft">&#160;</td><td class="mdescRight">Whether the tweens on the child game objects will be considered.  <a href="#a723dcbc852edfe53697136179b455111">More...</a><br /></td></tr>
<tr class="separator:a723dcbc852edfe53697136179b455111"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a039a1748b519953524732bc7d4611265"><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="class_event_delegate.html">EventDelegate</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_u_i_play_tween.html#a039a1748b519953524732bc7d4611265">onFinished</a> = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td></tr>
<tr class="memdesc:a039a1748b519953524732bc7d4611265"><td class="mdescLeft">&#160;</td><td class="mdescRight">Event delegates called when the animation finishes.  <a href="#a039a1748b519953524732bc7d4611265">More...</a><br /></td></tr>
<tr class="separator:a039a1748b519953524732bc7d4611265"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
Static Public Attributes</h2></td></tr>
<tr class="memitem:aa41d9dfc3baf005ea3cc730d91048220"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa41d9dfc3baf005ea3cc730d91048220"></a>
static <a class="el" href="class_u_i_play_tween.html">UIPlayTween</a>&#160;</td><td class="memItemRight" valign="bottom"><b>current</b></td></tr>
<tr class="separator:aa41d9dfc3baf005ea3cc730d91048220"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Play the specified tween on click. </p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a0c0efabeb715240734cedbef8756b8ee"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void UIPlayTween.Play </td>
          <td>(</td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>forward</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Activate the tweeners. </p>

</div>
</div>
<h2 class="groupheader">Member Data Documentation</h2>
<a class="anchor" id="ac54da7807c5285be86e60e1a1d4e4489"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">DisableCondition UIPlayTween.disableWhenFinished = DisableCondition.DoNotDisable</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>What to do with the tweenTarget after the tween finishes. </p>

</div>
</div>
<a class="anchor" id="a24e2ad0283d4eca2117c1e16cef8bf0b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">EnableCondition UIPlayTween.ifDisabledOnPlay = EnableCondition.DoNothing</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>What to do if the tweenTarget game object is currently disabled. </p>

</div>
</div>
<a class="anchor" id="a723dcbc852edfe53697136179b455111"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIPlayTween.includeChildren = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the tweens on the child game objects will be considered. </p>

</div>
</div>
<a class="anchor" id="a039a1748b519953524732bc7d4611265"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt; UIPlayTween.onFinished = new List&lt;<a class="el" href="class_event_delegate.html">EventDelegate</a>&gt;()</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Event delegates called when the animation finishes. </p>

</div>
</div>
<a class="anchor" id="afc50e0d18500e896042ee2730cf5f8bc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Direction UIPlayTween.playDirection = Direction.Forward</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Direction to tween in. </p>

</div>
</div>
<a class="anchor" id="a5b0fcbcbc3c97ff232176b68301f8dab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIPlayTween.resetIfDisabled = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the tween will be reset to the start if it's disabled when activated. </p>

</div>
</div>
<a class="anchor" id="a020e266016053125fc564ea00ea061a0"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">bool UIPlayTween.resetOnPlay = false</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Whether the tween will be reset to the start or end when activated. If not, it will continue from where it currently is. </p>

</div>
</div>
<a class="anchor" id="aaba49f1661ff32e1b2dd7b735cb8081e"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Trigger UIPlayTween.trigger = Trigger.OnClick</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Which event will trigger the tween. </p>

</div>
</div>
<a class="anchor" id="ac5c180c12d5c121bbda64913156612e5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int UIPlayTween.tweenGroup = 0</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>If there are multiple tweens, you can choose which ones get activated by changing their group. </p>

</div>
</div>
<a class="anchor" id="a37528d9cfda968571e39a90d7b63df46"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GameObject UIPlayTween.tweenTarget</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Target on which there is one or more tween. </p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>D:/WorkDir/Unity3D_Work/taidou_arpg/Assets/NGUI/Scripts/Interaction/UIPlayTween.cs</li>
</ul>
</div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
  <ul>
    <li class="navelem"><a class="el" href="class_u_i_play_tween.html">UIPlayTween</a></li>
    <li class="footer">Generated on Sat Jan 4 2020 22:30:28 for NGUI by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.9 </li>
  </ul>
</div>
</body>
</html>
